<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>py3dtilers.Color API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>py3dtilers.Color</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from .color_config import ColorConfig


__all__ = [&#39;ColorConfig&#39;]</code></pre>
</details>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="py3dtilers.Color.color_config" href="color_config.html">py3dtilers.Color.color_config</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="py3dtilers.Color.ColorConfig"><code class="flex name class">
<span>class <span class="ident">ColorConfig</span></span>
<span>(</span><span>config_path='D:\\Github\\py3dtilers\\py3dtilers\\Color\\default_config.json')</span>
</code></dt>
<dd>
<div class="desc"><p>A ColorConfig contains the color codes used to create colored materials.
The color codes can be loaded from a JSON file.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ColorConfig():
    &#34;&#34;&#34;
    A ColorConfig contains the color codes used to create colored materials.
    The color codes can be loaded from a JSON file.
    &#34;&#34;&#34;

    default_color = [1, 1, 1]

    min_color = [0, 1, 0]
    max_color = [1, 0, 0]
    nb_colors = 20

    color_dict = {
        &#39;default&#39;: [1, 1, 1]
    }

    def __init__(self, config_path=os.path.join(os.path.dirname(__file__), &#34;default_config.json&#34;)):
        if config_path is not None:
            try:
                with open(config_path) as f:
                    content = json.load(f)
                self.default_color = content[&#39;default_color&#39;] if &#39;default_color&#39; in content else self.default_color
                self.min_color = content[&#39;min_color&#39;] if &#39;min_color&#39; in content else self.min_color
                self.max_color = content[&#39;max_color&#39;] if &#39;max_color&#39; in content else self.max_color
                self.nb_colors = content[&#39;nb_colors&#39;] if &#39;nb_colors&#39; in content else self.nb_colors
                self.color_dict = content[&#39;color_dict&#39;] if &#39;color_dict&#39; in content else self.color_dict
            except FileNotFoundError:
                print(&#34;The config file&#34;, config_path, &#34;wasn&#39;t found.&#34;)
        self.min_color_code = self.to_material(self.min_color).rgba[:3]
        self.max_color_code = self.to_material(self.max_color).rgba[:3]

    def to_material(self, color):
        &#34;&#34;&#34;
        Create a GlTFMaterial from a color code.
        :param color: a color code (rgb or hexa)

        :return: a GlTFMaterial
        &#34;&#34;&#34;
        if isinstance(color, list):
            return GlTFMaterial(rgb=color)
        elif all(c in string.hexdigits for c in color.replace(&#39;#&#39;, &#39;&#39;).replace(&#39;0x&#39;, &#39;&#39;)):
            return GlTFMaterial.from_hexa(color)
        else:
            return GlTFMaterial()

    def get_color_by_key(self, key):
        &#34;&#34;&#34;
        Get the color corresponding to the key.
        :param key: the key in the color dictionary

        :return: a GlTFMaterial
        &#34;&#34;&#34;
        if key in self.color_dict:
            return self.to_material(self.color_dict[key])
        elif &#39;default&#39; in self.color_dict:
            return self.to_material(self.color_dict[&#39;default&#39;])
        else:
            self.get_default_color()

    def get_color_by_lerp(self, factor=0):
        &#34;&#34;&#34;
        Get a color by interpolation between two colors (min and max colors).
        :param float factor: the lerp factor

        :return: a GlTFMaterial
        &#34;&#34;&#34;
        return self.to_material([(max - min) * factor + min for min, max in zip(self.min_color_code, self.max_color_code)])

    def get_default_color(self):
        &#34;&#34;&#34;
        Get the default color.
        :return: a GlTFMaterial
        &#34;&#34;&#34;
        return self.to_material(self.default_color)</code></pre>
</details>
<h3>Class variables</h3>
<dl>
<dt id="py3dtilers.Color.ColorConfig.color_dict"><code class="name">var <span class="ident">color_dict</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="py3dtilers.Color.ColorConfig.default_color"><code class="name">var <span class="ident">default_color</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="py3dtilers.Color.ColorConfig.max_color"><code class="name">var <span class="ident">max_color</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="py3dtilers.Color.ColorConfig.min_color"><code class="name">var <span class="ident">min_color</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="py3dtilers.Color.ColorConfig.nb_colors"><code class="name">var <span class="ident">nb_colors</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="py3dtilers.Color.ColorConfig.get_color_by_key"><code class="name flex">
<span>def <span class="ident">get_color_by_key</span></span>(<span>self, key)</span>
</code></dt>
<dd>
<div class="desc"><p>Get the color corresponding to the key.
:param key: the key in the color dictionary</p>
<p>:return: a GlTFMaterial</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_color_by_key(self, key):
    &#34;&#34;&#34;
    Get the color corresponding to the key.
    :param key: the key in the color dictionary

    :return: a GlTFMaterial
    &#34;&#34;&#34;
    if key in self.color_dict:
        return self.to_material(self.color_dict[key])
    elif &#39;default&#39; in self.color_dict:
        return self.to_material(self.color_dict[&#39;default&#39;])
    else:
        self.get_default_color()</code></pre>
</details>
</dd>
<dt id="py3dtilers.Color.ColorConfig.get_color_by_lerp"><code class="name flex">
<span>def <span class="ident">get_color_by_lerp</span></span>(<span>self, factor=0)</span>
</code></dt>
<dd>
<div class="desc"><p>Get a color by interpolation between two colors (min and max colors).
:param float factor: the lerp factor</p>
<p>:return: a GlTFMaterial</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_color_by_lerp(self, factor=0):
    &#34;&#34;&#34;
    Get a color by interpolation between two colors (min and max colors).
    :param float factor: the lerp factor

    :return: a GlTFMaterial
    &#34;&#34;&#34;
    return self.to_material([(max - min) * factor + min for min, max in zip(self.min_color_code, self.max_color_code)])</code></pre>
</details>
</dd>
<dt id="py3dtilers.Color.ColorConfig.get_default_color"><code class="name flex">
<span>def <span class="ident">get_default_color</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Get the default color.
:return: a GlTFMaterial</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_default_color(self):
    &#34;&#34;&#34;
    Get the default color.
    :return: a GlTFMaterial
    &#34;&#34;&#34;
    return self.to_material(self.default_color)</code></pre>
</details>
</dd>
<dt id="py3dtilers.Color.ColorConfig.to_material"><code class="name flex">
<span>def <span class="ident">to_material</span></span>(<span>self, color)</span>
</code></dt>
<dd>
<div class="desc"><p>Create a GlTFMaterial from a color code.
:param color: a color code (rgb or hexa)</p>
<p>:return: a GlTFMaterial</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def to_material(self, color):
    &#34;&#34;&#34;
    Create a GlTFMaterial from a color code.
    :param color: a color code (rgb or hexa)

    :return: a GlTFMaterial
    &#34;&#34;&#34;
    if isinstance(color, list):
        return GlTFMaterial(rgb=color)
    elif all(c in string.hexdigits for c in color.replace(&#39;#&#39;, &#39;&#39;).replace(&#39;0x&#39;, &#39;&#39;)):
        return GlTFMaterial.from_hexa(color)
    else:
        return GlTFMaterial()</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="py3dtilers" href="../index.html">py3dtilers</a></code></li>
</ul>
</li>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="py3dtilers.Color.color_config" href="color_config.html">py3dtilers.Color.color_config</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="py3dtilers.Color.ColorConfig" href="#py3dtilers.Color.ColorConfig">ColorConfig</a></code></h4>
<ul class="two-column">
<li><code><a title="py3dtilers.Color.ColorConfig.color_dict" href="#py3dtilers.Color.ColorConfig.color_dict">color_dict</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.default_color" href="#py3dtilers.Color.ColorConfig.default_color">default_color</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.get_color_by_key" href="#py3dtilers.Color.ColorConfig.get_color_by_key">get_color_by_key</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.get_color_by_lerp" href="#py3dtilers.Color.ColorConfig.get_color_by_lerp">get_color_by_lerp</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.get_default_color" href="#py3dtilers.Color.ColorConfig.get_default_color">get_default_color</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.max_color" href="#py3dtilers.Color.ColorConfig.max_color">max_color</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.min_color" href="#py3dtilers.Color.ColorConfig.min_color">min_color</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.nb_colors" href="#py3dtilers.Color.ColorConfig.nb_colors">nb_colors</a></code></li>
<li><code><a title="py3dtilers.Color.ColorConfig.to_material" href="#py3dtilers.Color.ColorConfig.to_material">to_material</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>